-
Notifications
You must be signed in to change notification settings - Fork 1.8k
OBSDOCS-1860: Release Notes (RNs) for OpenShift Logging 6.3 Release #96021
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
OBSDOCS-1860: Release Notes (RNs) for OpenShift Logging 6.3 Release #96021
Conversation
@theashiot: This pull request references OBSDOCS-1860 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
Skipping CI for Draft Pull Request. |
/test all |
🤖 Wed Jul 16 12:14:08 - Prow CI generated the docs preview: https://96021--ocpdocs-pr.netlify.app/openshift-logging/latest/about/logging-release-notes.html |
/test all |
@theashiot: This pull request references OBSDOCS-1860 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
a592b4b
to
8ed6d77
Compare
/label peer-review-needed |
/label peer-review-in-progress |
* With this release, default values of Splunk metadata keys: index, indexed fields, source, and message payload are predefined for log forwarders. The values are based on the log type. As a user, you can override these values. (https://issues.redhat.com/browse/LOG-6859[LOG-6859]) | ||
|
||
=== Log storage | ||
* With this release, you can specify the S3 secret in the `forcepathstyle` field. Use this field to configure Loki to use either path style or virtual host style S3 URL. By default, {aws-short} endpoints use the virtual host style URL, equivalent to setting the `forcepathstyle` attribute to `false`. (https://issues.redhat.com/browse/LOG-7024?[LOG-7024]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The first sentence sounds a bit weird. Maybe something like this?
* With this release, you can specify the S3 secret in the `forcepathstyle` field. Use this field to configure Loki to use either path style or virtual host style S3 URL. By default, {aws-short} endpoints use the virtual host style URL, equivalent to setting the `forcepathstyle` attribute to `false`. (https://issues.redhat.com/browse/LOG-7024?[LOG-7024]) | |
* With this release, you can use the `forcepathstyle` field in the S3 secret. Use this field to configure Loki to use either path style or virtual host style for the S3 access. By default, only {aws-short} endpoints use the virtual host style URL, while others use path-style. (https://issues.redhat.com/browse/LOG-7024?[LOG-7024]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As Ashwin needs to add more bug fixes, I'm closing my review.
I'm onboarding as a peer reviewer, so please wait for @skopacz1 to approve my review before you proceed with my suggested changes.
[id="openshift-logging-release-notes-6-3-0-enhancements_{context}"] | ||
== New features and enhancements | ||
|
||
=== Log Collection |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use sentence-style capitalization
=== Log Collection | |
=== Log collection |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
|
||
=== Log Collection | ||
|
||
* With this release, you can configure multiple {aws-first} outputs with distinct IAM roles in the `clusterLogForwarder` resource. (https://issues.redhat.com/browse/LOG-6790[LOG-6790]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion to define IAM, if applicable:
* With this release, you can configure multiple {aws-first} outputs with distinct IAM roles in the `clusterLogForwarder` resource. (https://issues.redhat.com/browse/LOG-6790[LOG-6790]) | |
* With this release, you can configure multiple {aws-first} outputs with distinct identity and access management (IAM) roles in the `clusterLogForwarder` resource. (https://issues.redhat.com/browse/LOG-6790[LOG-6790]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
|
||
* With this release, you can configure affinity rules to control collector scheduling. (https://issues.redhat.com/browse/LOG-6858[LOG-6858]) | ||
|
||
* With this release, default values of Splunk metadata keys: index, indexed fields, source, and message payload are predefined for log forwarders. The values are based on the log type. As a user, you can override these values. (https://issues.redhat.com/browse/LOG-6859[LOG-6859]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the colon:
* With this release, default values of Splunk metadata keys: index, indexed fields, source, and message payload are predefined for log forwarders. The values are based on the log type. As a user, you can override these values. (https://issues.redhat.com/browse/LOG-6859[LOG-6859]) | |
* With this release, the default values of Splunk metadata keys (that is, index, indexed fields, source, and message payload) are predefined for log forwarders. The values are based on the log type. As a user, you can override these values. (https://issues.redhat.com/browse/LOG-6859[LOG-6859]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
* With this release, default values of Splunk metadata keys: index, indexed fields, source, and message payload are predefined for log forwarders. The values are based on the log type. As a user, you can override these values. (https://issues.redhat.com/browse/LOG-6859[LOG-6859]) | ||
|
||
=== Log storage | ||
* With this release, you can specify the S3 secret in the `forcepathstyle` field. Use this field to configure Loki to use either path style or virtual host style S3 URL. By default, {aws-short} endpoints use the virtual host style URL, equivalent to setting the `forcepathstyle` attribute to `false`. (https://issues.redhat.com/browse/LOG-7024?[LOG-7024]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion for clarity:
* With this release, you can specify the S3 secret in the `forcepathstyle` field. Use this field to configure Loki to use either path style or virtual host style S3 URL. By default, {aws-short} endpoints use the virtual host style URL, equivalent to setting the `forcepathstyle` attribute to `false`. (https://issues.redhat.com/browse/LOG-7024?[LOG-7024]) | |
* With this release, you can specify the S3 secret in the `forcepathstyle` field. Use this field to configure the Loki Operator to use either the path style or the virtual host style S3 URL. By default, {aws-short} endpoints use the virtual host style URL, which is equivalent to setting the `forcepathstyle` attribute to `false`. (https://issues.redhat.com/browse/LOG-7024?[LOG-7024]) |
* Before this update, alerting rules created by the {loki-op} incorrectly used the `message` field to display the message related to the alert. With this update, the alerting rules correctly use the `description` field. | ||
(https://issues.redhat.com/browse/LOG-6380[LOG-6380]) | ||
|
||
* Before this update, alerting rules were visible in unrelated namespaces due to lack of filtering based on the namespace in the Prometheus rules endpoint. As a consequence, user alerts were visible in unrelated namespaces. With this update, rule label filters have been added to the handler configuration, preventing alerts from being visible in unrelated namespaces. As a result, alert visibility is now restricted to the original namespace. (https://issues.redhat.com/browse/LOG-6148[LOG-6148]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestions to avoid duplication:
* Before this update, alerting rules were visible in unrelated namespaces due to lack of filtering based on the namespace in the Prometheus rules endpoint. As a consequence, user alerts were visible in unrelated namespaces. With this update, rule label filters have been added to the handler configuration, preventing alerts from being visible in unrelated namespaces. As a result, alert visibility is now restricted to the original namespace. (https://issues.redhat.com/browse/LOG-6148[LOG-6148]) | |
* Before this update, because of a lack of filtering based on the namespace in the Prometheus rules endpoint, user alerts were visible in unrelated namespaces. With this update, rule label filters have been added to the handler configuration. As a result, alert visibility is now restricted to the original namespace. (https://issues.redhat.com/browse/LOG-6148[LOG-6148]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice suggestion, thanks, updated!
|
||
* Before this update, alerting rules were visible in unrelated namespaces due to lack of filtering based on the namespace in the Prometheus rules endpoint. As a consequence, user alerts were visible in unrelated namespaces. With this update, rule label filters have been added to the handler configuration, preventing alerts from being visible in unrelated namespaces. As a result, alert visibility is now restricted to the original namespace. (https://issues.redhat.com/browse/LOG-6148[LOG-6148]) | ||
|
||
* Before this update, `ClusterLogForwarder` CR status updates failed due to an incorrect patching method. As a consequence, the {clo} failed to update objects, causing log data inconsistencies. With this release, `ClusterLogForwarder` CR status uses the `Patch()` method instead of the `Update()` method. As a result, the {clo} no longer fails to update the object, improving log forwarding stability. (https://issues.redhat.com/browse/LOG-6539[LOG-6539]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion for clarity:
* Before this update, `ClusterLogForwarder` CR status updates failed due to an incorrect patching method. As a consequence, the {clo} failed to update objects, causing log data inconsistencies. With this release, `ClusterLogForwarder` CR status uses the `Patch()` method instead of the `Update()` method. As a result, the {clo} no longer fails to update the object, improving log forwarding stability. (https://issues.redhat.com/browse/LOG-6539[LOG-6539]) | |
* Before this update, `ClusterLogForwarder` CR status updates failed due to an incorrect patching method. As a consequence, the {clo} failed to update objects, which caused log data inconsistencies. With this release, `ClusterLogForwarder` CR status uses the `Patch()` method instead of the `Update()` method. As a result, the {clo} no longer fails to update the object, which improves log forwarding stability. (https://issues.redhat.com/browse/LOG-6539[LOG-6539]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
03342d1
to
78f33a4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is sort of a weird situation where Brendan only did a half review, but all of his comments look good to me. If you're still making changes to the PR, I think this would still need another peer review though
/remove-label peer-review-needed |
Thaks, @brendan-daly-red-hat and @skopacz1 for the review! Apologies for the trouble. I've now added the missing content. I agree that this needs to be reviewed again. |
/label peer-review-needed |
Should below issues be added under known issues? |
Thanks, @brendan-daly-red-hat and @skopacz1 for the wonderful review! I've made all the suggested changes. best, |
These will be included in the next z-stream release. |
it is better to remove these bugs. these bugs had been released in Logging 6.2 z-stream. LOG-6711 When forwarding logs with Otel data module, vector pod cannot forward ovn audit logs |
we should include this bug. |
This one's mentioned: https://github.com/openshift/openshift-docs/pull/96021/files#diff-615a1a88d52eafeb9b7cd91143bb5ea4e065d568bdd0fefc3d17829423b7328fR42 |
I've commented these out. They are not visible in the output now: https://96021--ocpdocs-pr.netlify.app/openshift-logging/latest/about/logging-release-notes.html |
@theashiot: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
/remove-label peer-review-needed |
/label merge-review-needed |
/lgtm |
@theashiot: This pull request references OBSDOCS-1860 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
Thanks, @anpingli!! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/LGTM
9bb0269
into
openshift:standalone-logging-docs-main
/cherrypick standalone-logging-docs-6.3 |
@gabriel-rh: new pull request created: #96170 In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
Version(s): 6.3
Issue: OBSDOCS-1860
Link to docs preview: https://96021--ocpdocs-pr.netlify.app/openshift-logging/latest/about/logging-release-notes.html
QE review:
Additional information: